Get a Single AI Agent by ID

Used to retrieve detailed information for a specific AI agent using its unique identifier (UUID).

API Endpoint

Property	Value
Request Method	GET
Request URL	https://api.seliseblocks.com/agents/query/{agent_id}

Request

Request Example

curl -X GET 'https://api.seliseblocks.com/agents/query/a1b2c3d4-e5f6-7890-abcd-ef1234567890?project_key=YOUR_PROJECT_KEY' \
  -H 'accept: application/json'

Request Headers

Field	Type	Required	Description
accept	string	Yes	Accepted response format. Use application/json

Path Parameters

Field	Type	Required	Description
agent_id	string	Yes	UUID of the AI Agent to retrieve.

Query Parameters

Field	Type	Required	Description
project_key	string	No	Project key used to change context.

Response

Success Response (200 OK)

Returns an object containing the detailed agent information.

{
  "agent": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Customer Support Agent",
    "tags": ["support", "customer-service", "chatbot"],
    "role": "assistant",
    "description": "An AI agent specialized in handling customer support inquiries",
    "logo_url": "https://example.com/logo.png",
    "logo_id": "logo_123456",
    "is_disabled": false,
    "is_archived": false,
    "widget_id": "widget_789",
    "agent_type": "customer_support",
    "languages": ["en-US", "de-DE"],
    "organization_ids": ["org_123", "org_456"],
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-20T14:45:00Z",
    "llm_config": {
      "Provider": "openai",
      "ModelName": "gpt-4",
      "Temperature": 0.7,
      "MaxTokens": 2000
    },
    "widget": {
      "Name": "Support Chat Widget",
      "BrandColor": "#4F46E5",
      "Greeting": "Welcome! How can I help you today?"
    }
  }
}

Response Fields

Field	Type	Description
agent	object	Complete agent object with all configuration details.

Agent Object Fields

Field	Type	Description
id	string	Unique identifier of the agent.
name	string	Name of the agent.
tags	array	Array of tags associated with the agent.
role	string	Role of the agent (e.g., assistant, specialist).
description	string	Description of the agent's purpose and functionality.
logo_url	string	URL of the agent's logo image.
logo_id	string	Unique identifier for the logo asset.
is_disabled	boolean	Whether the agent is currently disabled.
is_archived	boolean	Whether the agent is archived.
widget_id	string	Identifier of the associated widget.
agent_type	string	Type of the agent (e.g., customer_support, sales).
languages	array	Array of supported language codes.
organization_ids	array	Array of organization identifiers.
created_at	string	ISO 8601 timestamp of when the agent was created.
updated_at	string	ISO 8601 timestamp of the last update.
llm_config	object	Large Language Model configuration settings.
widget	object	Widget configuration details.

note

The response structure may include additional nested objects such as rag_config, guardrail, memory_config, and tool_ids depending on the agent's configuration.

Error Response (422 Unprocessable Entity)

Returns validation error details when the request parameters are invalid.

{
  "detail": [
    {
      "loc": [
        "path",
        "agent_id"
      ],
      "msg": "invalid UUID format",
      "type": "type_error.uuid"
    }
  ]
}

Error Response Fields

Field	Type	Description
detail	array	Array of validation error objects.
loc	array	Location of the error in the request (e.g., path, query).
msg	string	Human-readable error message.
type	string	Error type identifier.

Error Codes

Status Code	Description	Response Type
200	Successful Response	Success
404	Agent Not Found	Not Found
422	Validation Error - Invalid request parameters	Unprocessable Entity